<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.dataConnector.html">dataConnector</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="discoveryengine_v1alpha.projects.locations.collections.dataConnector.connectorRuns.html">connectorRuns()</a></code>
</p>
<p class="firstline">Returns the connectorRuns Resource.</p>

<p class="toc_element">
  <code><a href="discoveryengine_v1alpha.projects.locations.collections.dataConnector.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>

<p class="toc_element">
  <code><a href="#acquireAccessToken">acquireAccessToken(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI.</p>
<p class="toc_element">
  <code><a href="#checkRefreshToken">checkRefreshToken(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deprecated: Checks the existence of a refresh token for the EUC user for a given connection and returns its details. Use AcquireAccessToken instead and then check the validity of the returned token by asking the 3rd party system. There's no way to know for sure if a refresh token is valid without asking the 3rd party system.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#getConnectorSecret">getConnectorSecret(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get the secret for the associated connector.</p>
<p class="toc_element">
  <code><a href="#startConnectorRun">startConnectorRun(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="acquireAccessToken">acquireAccessToken(name, body=None, x__xgafv=None)</code>
  <pre>Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI.

Args:
  name: string, Required. The resource name of the connector for which a token is queried. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the DataConnectorService.AcquireAccessToken method.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the DataConnectorService.AcquireAccessToken method.
  &quot;accessToken&quot;: &quot;A String&quot;, # The created access token.
  &quot;refreshTokenInfo&quot;: { # Describes a refresh token. # Info about the stored refresh token used to create the access token.
    &quot;name&quot;: &quot;A String&quot;, # Required. The connection for which this token applies.
    &quot;scopes&quot;: [ # The list of scopes for this token.
      &quot;A String&quot;,
    ],
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="checkRefreshToken">checkRefreshToken(name, x__xgafv=None)</code>
  <pre>Deprecated: Checks the existence of a refresh token for the EUC user for a given connection and returns its details. Use AcquireAccessToken instead and then check the validity of the returned token by asking the 3rd party system. There&#x27;s no way to know for sure if a refresh token is valid without asking the 3rd party system.

Args:
  name: string, Required. The resource name of the connector for which a token is queried. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the DataConnectorService.CheckRefreshToken method.
  &quot;refreshTokenInfo&quot;: { # Describes a refresh token. # Info about the stored refresh token.
    &quot;name&quot;: &quot;A String&quot;, # Required. The connection for which this token applies.
    &quot;scopes&quot;: [ # The list of scopes for this token.
      &quot;A String&quot;,
    ],
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="getConnectorSecret">getConnectorSecret(name, x__xgafv=None)</code>
  <pre>Get the secret for the associated connector.

Args:
  name: string, Required. The full resource name of the associated data connector. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for DataConnectorService.GetConnectorSecret.
  &quot;app&quot;: &quot;A String&quot;, # The app name of the associated Connector.
  &quot;authorizationUri&quot;: &quot;A String&quot;, # The authorization uri for the data connector.
  &quot;clientId&quot;: &quot;A String&quot;, # The client id of the associated Connector.
  &quot;instance&quot;: &quot;A String&quot;, # The instance name of the associated Connector.
  &quot;redirectUri&quot;: &quot;A String&quot;, # The redirect url of the associated Connector.
  &quot;tenantId&quot;: &quot;A String&quot;, # The tenant id of the associated Connector.
}</pre>
</div>

<div class="method">
    <code class="details" id="startConnectorRun">startConnectorRun(parent, body=None, x__xgafv=None)</code>
  <pre>Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced.

Args:
  parent: string, Required. Connector name of the form projects/{project}/locations/{location}/collections/ {collection_id}/dataConnector (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for DataConnectorService.StartConnectorRun method.
  &quot;entities&quot;: [ # Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced.
    &quot;A String&quot;,
  ],
  &quot;forceRefreshContent&quot;: True or False, # Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.
  &quot;healthcareFhirResourceTypes&quot;: [ # The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty.
    &quot;A String&quot;,
  ],
  &quot;syncIdentity&quot;: True or False, # If true, trigger Identity sync.
  &quot;syncSinceTimestamp&quot;: &quot;A String&quot;, # Timestamp to indicate the point in time from which data should be synced for Streaming/Batch Data Connectors. This field is only utilized for Healthcare Connectors.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the connector run ended.
  &quot;entityRuns&quot;: [ # Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.
    { # Represents an entity that was synced in this ConnectorRun.
      &quot;deletedRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents deleted.
      &quot;entityName&quot;: &quot;A String&quot;, # The name of the source entity.
      &quot;errorRecordCount&quot;: &quot;A String&quot;, # Optional. The total number of documents failed at sync at indexing stage.
      &quot;errors&quot;: [ # The errors from the entity&#x27;s sync run. Only exist if running into an error state. Contains error code and error message.
        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
        },
      ],
      &quot;extractedRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents extracted from connector source, ready to be ingested to VAIS.
      &quot;indexedRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents indexed.
      &quot;progress&quot;: { # Represents the progress of a sync run. # Metadata to generate the progress bar.
        &quot;currentCount&quot;: &quot;A String&quot;, # The current progress.
        &quot;percentile&quot;: 3.14, # Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.
        &quot;totalCount&quot;: &quot;A String&quot;, # The total.
      },
      &quot;scheduledRecordCount&quot;: &quot;A String&quot;, # Optional. The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors.
      &quot;sourceApiRequestCount&quot;: &quot;A String&quot;, # Optional. The number of requests sent to 3p API.
      &quot;state&quot;: &quot;A String&quot;, # The state of the entity&#x27;s sync run.
      &quot;stateUpdateTime&quot;: &quot;A String&quot;, # Timestamp at which the entity sync state was last updated.
      &quot;statsUpdateTime&quot;: &quot;A String&quot;, # The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated.
      &quot;syncType&quot;: &quot;A String&quot;, # Sync type of this run.
    },
  ],
  &quot;errors&quot;: [ # Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field.
    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
      &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    },
  ],
  &quot;latestPauseTime&quot;: &quot;A String&quot;, # Output only. The time when the connector run was most recently paused.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.
  &quot;startTime&quot;: &quot;A String&quot;, # Output only. The time when the connector run started.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the sync run.
  &quot;stateUpdateTime&quot;: &quot;A String&quot;, # Timestamp at which the connector run sync state was last updated.
  &quot;trigger&quot;: &quot;A String&quot;, # Output only. The trigger for this ConnectorRun.
}</pre>
</div>

</body></html>